home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / AIncludes / QD3DSet.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  9.5 KB  |  321 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DSet.a
  3. ;
  4. ;    Contains:    Q3Set types and routines                                            
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__QD3DSET__') = 'UNDEFINED' THEN
  18. __QD3DSET__ SET 1
  19.  
  20.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  21.     include 'QD3D.a'
  22.     ENDIF
  23.  
  24. ; ******************************************************************************
  25. ; **                                                                             **
  26. ; **                                Set Routines                                 **
  27. ; **                                                                             **
  28. ; ****************************************************************************
  29.  
  30. ;
  31. ; extern TQ3SetObject Q3Set_New(void )
  32. ;
  33.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  34.         IMPORT_CFM_FUNCTION Q3Set_New
  35.     ENDIF
  36.  
  37. ;
  38. ; extern TQ3ObjectType Q3Set_GetType(TQ3SetObject theSet)
  39. ;
  40.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  41.         IMPORT_CFM_FUNCTION Q3Set_GetType
  42.     ENDIF
  43.  
  44. ;
  45. ; extern TQ3Status Q3Set_Add(TQ3SetObject theSet, TQ3ElementType theType, const void *data)
  46. ;
  47.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  48.         IMPORT_CFM_FUNCTION Q3Set_Add
  49.     ENDIF
  50.  
  51. ;
  52. ; extern TQ3Status Q3Set_Get(TQ3SetObject theSet, TQ3ElementType theType, void *data)
  53. ;
  54.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  55.         IMPORT_CFM_FUNCTION Q3Set_Get
  56.     ENDIF
  57.  
  58. ;
  59. ; extern TQ3Boolean Q3Set_Contains(TQ3SetObject theSet, TQ3ElementType theType)
  60. ;
  61.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  62.         IMPORT_CFM_FUNCTION Q3Set_Contains
  63.     ENDIF
  64.  
  65. ;
  66. ; extern TQ3Status Q3Set_Clear(TQ3SetObject theSet, TQ3ElementType theType)
  67. ;
  68.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  69.         IMPORT_CFM_FUNCTION Q3Set_Clear
  70.     ENDIF
  71.  
  72. ;
  73. ; extern TQ3Status Q3Set_Empty(TQ3SetObject target)
  74. ;
  75.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  76.         IMPORT_CFM_FUNCTION Q3Set_Empty
  77.     ENDIF
  78.  
  79. ; 
  80. ; *  Iterating through all elements in a set
  81. ; *
  82. ; *  Pass in kQ3ElementTypeNone to get first type
  83. ; *  kQ3ElementTypeNone is returned when end of list is reached
  84. ; 
  85.  
  86. ;
  87. ; extern TQ3Status Q3Set_GetNextElementType(TQ3SetObject theSet, TQ3ElementType *theType)
  88. ;
  89.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  90.         IMPORT_CFM_FUNCTION Q3Set_GetNextElementType
  91.     ENDIF
  92.  
  93.  
  94. ; ******************************************************************************
  95. ; **                                                                             **
  96. ; **                                Attribute Types                                 **
  97. ; **                                                                             **
  98. ; ****************************************************************************
  99.  
  100. ;  
  101. ; *    For the data types listed below, pass in a pointer to it in the _Add 
  102. ; *    and _Get calls.
  103. ; *
  104. ; *    For surface shader attributes, reference counts are incremented on 
  105. ; *    the _Add and _Get 
  106. ; 
  107.  
  108.  
  109. ; typedef long                            TQ3AttributeTypes
  110.                                                             ; Data Type                
  111. kQ3AttributeTypeNone            EQU        0                    ; ---------                
  112. kQ3AttributeTypeSurfaceUV        EQU        1                    ; TQ3Param2D                
  113. kQ3AttributeTypeShadingUV        EQU        2                    ; TQ3Param2D                 
  114. kQ3AttributeTypeNormal            EQU        3                    ; TQ3Vector3D                 
  115. kQ3AttributeTypeAmbientCoefficient EQU    4                    ; float                     
  116. kQ3AttributeTypeDiffuseColor    EQU        5                    ; TQ3ColorRGB                
  117. kQ3AttributeTypeSpecularColor    EQU        6                    ; TQ3ColorRGB                
  118. kQ3AttributeTypeSpecularControl    EQU        7                    ; float                    
  119. kQ3AttributeTypeTransparencyColor EQU    8                    ; TQ3ColorRGB                
  120. kQ3AttributeTypeSurfaceTangent    EQU        9                    ; TQ3Tangent2D              
  121. kQ3AttributeTypeHighlightState    EQU        10                    ; TQ3Switch                 
  122. kQ3AttributeTypeSurfaceShader    EQU        11                    ; TQ3SurfaceShaderObject    
  123. kQ3AttributeTypeNumTypes        EQU        12
  124. ; typedef TQ3ElementType                 TQ3AttributeType
  125.  
  126. ; ******************************************************************************
  127. ; **                                                                             **
  128. ; **                                Attribute Drawing                             **
  129. ; **                                                                             **
  130. ; ****************************************************************************
  131.  
  132. ;
  133. ; extern TQ3Status Q3Attribute_Submit(TQ3AttributeType attributeType, const void *data, TQ3ViewObject view)
  134. ;
  135.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  136.         IMPORT_CFM_FUNCTION Q3Attribute_Submit
  137.     ENDIF
  138.  
  139.  
  140. ; ******************************************************************************
  141. ; **                                                                             **
  142. ; **                            AttributeSet Routines                             **
  143. ; **                                                                             **
  144. ; ****************************************************************************
  145.  
  146. ;
  147. ; extern TQ3AttributeSet Q3AttributeSet_New(void )
  148. ;
  149.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  150.         IMPORT_CFM_FUNCTION Q3AttributeSet_New
  151.     ENDIF
  152.  
  153. ;
  154. ; extern TQ3Status Q3AttributeSet_Add(TQ3AttributeSet attributeSet, TQ3AttributeType theType, const void *data)
  155. ;
  156.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  157.         IMPORT_CFM_FUNCTION Q3AttributeSet_Add
  158.     ENDIF
  159.  
  160. ;
  161. ; extern TQ3Boolean Q3AttributeSet_Contains(TQ3AttributeSet attributeSet, TQ3AttributeType attributeType)
  162. ;
  163.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  164.         IMPORT_CFM_FUNCTION Q3AttributeSet_Contains
  165.     ENDIF
  166.  
  167. ;
  168. ; extern TQ3Status Q3AttributeSet_Get(TQ3AttributeSet attributeSet, TQ3AttributeType theType, void *data)
  169. ;
  170.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  171.         IMPORT_CFM_FUNCTION Q3AttributeSet_Get
  172.     ENDIF
  173.  
  174. ;
  175. ; extern TQ3Status Q3AttributeSet_Clear(TQ3AttributeSet attributeSet, TQ3AttributeType theType)
  176. ;
  177.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  178.         IMPORT_CFM_FUNCTION Q3AttributeSet_Clear
  179.     ENDIF
  180.  
  181. ;
  182. ; extern TQ3Status Q3AttributeSet_Empty(TQ3AttributeSet target)
  183. ;
  184.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  185.         IMPORT_CFM_FUNCTION Q3AttributeSet_Empty
  186.     ENDIF
  187.  
  188. ; 
  189. ; * Q3AttributeSet_GetNextAttributeType
  190. ; *
  191. ; * Pass in kQ3AttributeTypeNone to get first type
  192. ; * kQ3AttributeTypeNone is returned when end of list is reached
  193. ; 
  194.  
  195. ;
  196. ; extern TQ3Status Q3AttributeSet_GetNextAttributeType(TQ3AttributeSet source, TQ3AttributeType *theType)
  197. ;
  198.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  199.         IMPORT_CFM_FUNCTION Q3AttributeSet_GetNextAttributeType
  200.     ENDIF
  201.  
  202. ;
  203. ; extern TQ3Status Q3AttributeSet_Submit(TQ3AttributeSet attributeSet, TQ3ViewObject view)
  204. ;
  205.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  206.         IMPORT_CFM_FUNCTION Q3AttributeSet_Submit
  207.     ENDIF
  208.  
  209. ; 
  210. ; * Inherit from parent->child into result
  211. ; *    Result attributes are:
  212. ; *        all child attributes + all parent attributes NOT in the child
  213. ; 
  214.  
  215. ;
  216. ; extern TQ3Status Q3AttributeSet_Inherit(TQ3AttributeSet parent, TQ3AttributeSet child, TQ3AttributeSet result)
  217. ;
  218.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  219.         IMPORT_CFM_FUNCTION Q3AttributeSet_Inherit
  220.     ENDIF
  221.  
  222.  
  223. ; ******************************************************************************
  224. ; **                                                                             **
  225. ; **                            Custom Element Registration                         **
  226. ; **                                                                             **
  227. ; ****************************************************************************
  228.  
  229. ; 
  230. ; * Element Methods - 
  231. ; *
  232. ; *         When you create a custom element, you control what structures are 
  233. ; *        passed around the API. For example, you may allow the Q3Set_Add call 
  234. ; *        take one type of argument, store your element internally in some 
  235. ; *        abstract data type, and have the Q3Set_Get call take a different 
  236. ; *        argument.
  237. ; *
  238. ; *        For example:
  239. ; *            
  240. ; *        There are four calls which at some point will copy an element:
  241. ; *
  242. ; *        Q3Set_Add (copied from Application memory to QuickDraw3D memory)
  243. ; *        Q3Set_Get (copied from QuickDraw3D memory to Application memory)
  244. ; *        Q3Object_Duplicate (all elements are copied internally)
  245. ; *        Q3AttributeSet_Inherit (all elements are copied internally)
  246. ; *
  247. ; *         Either CopyAdd or CopyReplace is called during the "_Add" call.
  248. ; *            - CopyAdd is destructive and should assume "toElement" is garbage
  249. ; *            - CopyReplace is replacing an existing element.
  250. ; *
  251. ; *         CopyGet is called during the "_Get" call.
  252. ; *
  253. ; *         CopyDuplicate is called to duplicate an element's internal structure.
  254. ; *
  255. ; * Attributes Methods - 
  256. ; *
  257. ; *        For copying data while Inheriting. Element methods are used
  258. ; *        at all other times.
  259. ; *    
  260. ; *         CopyInherit is called to duplicate an element's internal structure 
  261. ; *            during inheritance. You should make this as fast as possible.
  262. ; *            (for example, if your custom element contains objects, you
  263. ; *             should do a Q3Shared_GetReference instead of a Q3Object_Duplicate)
  264. ; *            
  265. ; *        The ElementDelete method will be called for all of your elements 
  266. ; *        copied around via CopyAdd, CopyReplace, CopyDuplicate, and 
  267. ; *        CopyInherit.
  268. ; *        If CopyGet allocates any memory in it's destination, it is up to the 
  269. ; *        application to delete it on its side.
  270. ; 
  271.  
  272.  
  273. kQ3XMethodTypeElementCopyAdd    EQU        'ecpa'
  274. kQ3XMethodTypeElementCopyReplace EQU    'ecpr'
  275. kQ3XMethodTypeElementCopyGet    EQU        'ecpg'
  276. kQ3XMethodTypeElementCopyDuplicate EQU    'eccd'
  277. kQ3XMethodTypeElementDelete        EQU        'ecpl'
  278. ;
  279. ; extern TQ3XObjectClass Q3XElementClass_Register(TQ3ElementType *elementType, const char *name, unsigned long sizeOfElement, TQ3XMetaHandler metaHandler)
  280. ;
  281.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  282.         IMPORT_CFM_FUNCTION Q3XElementClass_Register
  283.     ENDIF
  284.  
  285. ;
  286. ; extern TQ3Status Q3XElementType_GetElementSize(TQ3ElementType elementType, unsigned long *sizeOfElement)
  287. ;
  288.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  289.         IMPORT_CFM_FUNCTION Q3XElementType_GetElementSize
  290.     ENDIF
  291.  
  292.  
  293. ; ******************************************************************************
  294. ; **                                                                             **
  295. ; **                        Custom Attribute Registration                         **
  296. ; **                                                                             **
  297. ; ****************************************************************************
  298.  
  299. ; typedef TQ3Boolean                     TQ3XAttributeInheritMethod
  300.  
  301. ;  return kQ3True or kQ3False in your metahandler 
  302. ;
  303. ; extern TQ3XObjectClass Q3XAttributeClass_Register(TQ3AttributeType *attributeType, const char *creatorName, unsigned long sizeOfElement, TQ3XMetaHandler metaHandler)
  304. ;
  305.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  306.         IMPORT_CFM_FUNCTION Q3XAttributeClass_Register
  307.     ENDIF
  308.  
  309. ; 
  310. ; *    Version 1.5
  311. ; 
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.     ENDIF ; __QD3DSET__ 
  320.  
  321.